- 
                Notifications
    You must be signed in to change notification settings 
- Fork 0
Update README and template #57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: devel
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comments inline
| ### 🧑💻 Setting Up the Configuration File | ||
|  | ||
| The test suite uses environment variables to store sensitive information such as endpoints and credentials. | ||
| The test suite uses environment variables to store sensitive information such as endpoints and credentials. I'd recommend that you have two environment files. The first includes the cluster information, and the second contains the authentication process credentials. This way, you can switch between authentication processes such as EGI-CheckIn or Keycloak. Also, you can create one environment file that contains all the information. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you recommend two environment files, include templates for the two files (now we have a single .env-template.yaml file). Include the attributes in each file with sample fake values. Also, include an example on how to specify the two files to the robot command.
| - `EGI_AAI_URL`: The base URL of the EGI AAI (Authentication and Authorisation Infrastructure) server. | ||
| - For the production server, use `https://aai.egi.eu`. | ||
| - For the demo server, use `https://aai-demo.egi.eu`. | ||
| - `REFRESH_TOKEN`: The OIDC token used to automate the execution of the test suite. In order to get a Refresh Token, head to the [Check-in Token Portal](https://aai.egi.eu/token/) or [Demo Check-in Token Portal](https://aai-demo.egi.eu/token/), click **Authorise** and then **Create Refresh Token** button to generate a new token. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the description it looks like refresh tokens can only be used with EGI Check-In. These should be possible to use also from Keycloak.
| In case you are testing isolation or visibility, you have to add a second user: | ||
| - `SECOND_USER`: User ID of the second user. **ALWAYS REQUIRED**. | ||
| - `REFRESH_TOKEN_SECOND_USER`: The OIDC token of the second user used to automate the execution. | ||
| - `KEYCLOAK_USERNAME_AUX` and `KEYCLOAK_PASSWORD_AUX`: The user/password of a second user in Keycloak. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You used "SECOND_USER" before, and here you are using "AUX" to refer to the second user. I suggest that the second user is referred to as "OTHER_USER" and maintain just "USER" for the first user.
        
          
                README.md
              
                Outdated
          
        
      | - `AAI_URL`: The URL token of the AAI (Authentication and Authorisation Infrastructure) server. **ALWAYS REQUIRED**. | ||
| - For the EGI production server, use `https://aai.egi.eu/auth/realms/egi/protocol/openid-connect/token`. | ||
| - For the EGI demo server, use `https://aai-demo.egi.eu/auth/realms/egi/protocol/openid-connect/token`. | ||
| - `AAI_VO`: The virtual organization used to test the OSCAR cluster. **ALWAYS REQUIRED**. | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
VO is a term from EGI Check-In. In general, we should talk about "Groups"
New README and template showing the new configuration.